home *** CD-ROM | disk | FTP | other *** search
/ Network Supervisor's Toolkit / Network Supervisor's Toolkit.iso / e-mail / mailbox / manual.doc < prev    next >
Text File  |  1996-07-10  |  6KB  |  331 lines

  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                                Mailbox SKIMMER v 1.1
  9.                                ---------------------
  10.                            ShareWare by Ernesto Garcia.
  11.  
  12.                                   User's Manual.
  13.  
  14.  
  15.  
  16.          Thank you for using Mailbox SKIMMER. This instructive is rather
  17.  
  18.        short, but it's everything you need to know how to use the program.
  19.  
  20.        If you are in a hurry, read the file MSKIM.TXT, as it has straight-
  21.  
  22.        to-the-point instructions for setup and use.
  23.  
  24.  
  25.  
  26.          DISCLAIMER
  27.  
  28.          Mailbox SKIMMER (the program) comes with no warranty of any kind,
  29.  
  30.        neither implicit nor explicit. The Author of this program shall not
  31.  
  32.        be responsible for any effect of the use of this program. You use it
  33.  
  34.        at your own risk.
  35.  
  36.          All the names of commercial products and software programs
  37.  
  38.        mentioned in this document are trademarks of their respective owners.
  39.  
  40.  
  41.  
  42.          WHAT IS MAILBOX SKIMMER?
  43.  
  44.          This is a program designed to select messages from a mailbox, by
  45.  
  46.        eliminating those ones that contain a specific string in the Subject:
  47.  
  48.        line of the header of its message. I wrote it because I was
  49.  
  50.        subscribed to a mailing list of my interest, but about half of the
  51.  
  52.        messages in the mailing list were about a particular subject I wasn't
  53.  
  54.        interested in.
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.  
  72.  
  73.          REQUIREMENTS
  74.  
  75.          Mailbox SKIMMER should run in any PC with 128k of RAM, but the more
  76.  
  77.        memory you have, it will be able to handle larger mailbox files. Your
  78.  
  79.        mailbox file should be in DOS text format, that is, with car returns
  80.  
  81.        and line feeds. A native Unix textfile won't work propperly with the
  82.  
  83.        program, but don't worry: if you are downloading your mailbox file
  84.  
  85.        from a Unix System, there should be a command in your Unix system
  86.  
  87.        which will let you convert from Unix to DOS type (unix2dos, aix2dos,
  88.  
  89.        or whatever). Use this command before copying or downloading your
  90.  
  91.        mailbox file. Then, it will be ready to be used by Mailbox SKIMMER. (
  92.  
  93.        There are also many commercial and ShareWare programs designed to
  94.  
  95.        convert files )
  96.  
  97.  
  98.  
  99.          HOW TO USE IT?
  100.  
  101.          Mailbox SKIMMER works under the assumption that we are working with
  102.  
  103.        a typical mailbox file: This is the general structure of a mailbox:
  104.  
  105.  
  106.          ------------------------------------------------------------------
  107.                           From user@server.node
  108.                           (lines...)
  109.                           Subject: topic of the message
  110.                           (lines...)
  111.  
  112.                           Beginning of actual message.
  113.                           (lines...)
  114.                           last line of message
  115.          ------------------------------------------------------------------
  116.  
  117.  
  118.  
  119.          The upper half of the message (the header) contains many
  120.  
  121.        informational lines; The Subject: line is the one which can by
  122.  
  123.        analysed to find the topics you want to eliminate.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.  
  138.  
  139.          Command Syntax:
  140.  
  141.              mskim [ -A file ] [ mboxfile: ]   unwanted topics
  142.  
  143.  
  144.  
  145.          Options:          -A   Another destination; Default is MBOX.DEP.
  146.  
  147.                      mboxfile   The name of your mailbox. Default is MBOX.
  148.  
  149.               unwanted topics   All strings that appear on the messages
  150.                                 you don't want to read.
  151.  
  152.          Note : Brackets mean it's optional.
  153.  
  154.  
  155.  
  156.          This is the only order in which parameters will work.
  157.  
  158.          It is *VERY* important to write the name of your mailbox followed
  159.  
  160.        by a colon ' : '. The colon is the only mean to tell a mailbox name
  161.  
  162.        from an unwanted topic. So, an unwanted topic may be any word, but it
  163.  
  164.        can't end with a colon.
  165.  
  166.  
  167.  
  168.          Examples of use:
  169.  
  170.  
  171.            mskim  -A c:\personal\readmail.txt f:mbox: greetings buy returned
  172.  
  173.  
  174.  
  175.          The example above would perform this: From file mbox stored in the
  176.  
  177.        F: drive, eliminate all messages containing the words 'greetings',
  178.  
  179.        'buy', and 'returned', outputting the results to the file
  180.  
  181.        c:\personal\readmail.txt (Note the colon after the mbox filename)
  182.  
  183.  
  184.  
  185.          If your mailbox is named MBOX., is in the current directory, and
  186.  
  187.        you want the skimmed mail to be named MBOX.DEP in that very same
  188.  
  189.        directory, the command would be as simple as this:
  190.  
  191.  
  192.                             mskim  greetings buy returned
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.          mskim will return the following DOS ERRORLEVEL after execution:
  206.  
  207.  
  208.  
  209.                                 0 :  Everything's ok
  210.  
  211.                                 1 :  No parameters were typen
  212.  
  213.                                 2 :  mailbox file does not exist
  214.  
  215.                                 3 :  Invalid name for output file
  216.  
  217.                                 4 :  mailbox and output file are the same
  218.  
  219.  
  220.  
  221.  
  222.  
  223.          FEEDBACK
  224.  
  225.          To submit questions, suggestions, register, or tell me anything
  226.  
  227.        concerning Mailbox SKIMMER, please contact me at the following
  228.  
  229.        adresses:
  230.  
  231.                       Internet :     ernesto.garcia@juge.com
  232.  
  233.                        Fidonet :     rainman@4:975/1
  234.  
  235.                     Snail mail :     Ernesto Garcia
  236.                                      Loma Hermosa 22-B-107.
  237.                                      Mexico, D.F. 11200
  238.                                      MEXICO
  239.  
  240.  
  241.  
  242.          SHAREWARE
  243.  
  244.          You are encouraged to copy and distribute this file freely to
  245.  
  246.        colleagues, BBSs, and FTP sites. If you find this program useful,
  247.  
  248.        please register it by sending U.S. $5.00 to this adress:
  249.  
  250.  
  251.                                      Ernesto Garcia
  252.                                      Loma Hermosa 22-B-107.
  253.                                      Mexico, D.F. 11200
  254.                                      MEXICO
  255.  
  256.  
  257.  
  258.  
  259.  
  260.  
  261.  
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269.  
  270.  
  271.          WHY REGISTER?
  272.  
  273.          Registering the ShareWare you use will encourage us, the ShareWare
  274.  
  275.        authors, to write more and better programs, available to you at a
  276.  
  277.        reasonable price.
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.